/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2021年6月19日
 */
package com.massyframework.beanskin.service.secure;

import java.util.Set;

/**
 * 安全加固能力
 * @author huangkh
 *
 */
public interface SecureCapacity {

	/**
	 * 是否为需要解密的类
	 * @param className {@link String}
	 * @return {@link boolean},返回{@code true}表示是，否则返回{@code false}
	 */
	boolean isDecryptClass(String className);
	
	/**
	 * 是否为需要解密的脚本文件
	 * @param fileName {@link String},文件名，包括classpath的相对路径部份.
	 * @return {@link boolean},返回{@code true}表示是，否则返回{@code false}
	 */
	boolean isDecryptScriptFile(String fileName);
	
	/**
	 * 解密公钥
	 * @return {@link String}
	 */
	String getPublicKey();
	
	/**
	 * x509证书名称，用于区份不同版本的证书
	 * @return {@link String},可能返回null.
	 */
	String getX509Name();
	
	/**
	 * 已加密的x509签名证书Md5
	 * <p>
	 * 无需许可的模块，不需要验证许可签名的证书，可以为null.
	 * @return {@link String}, 可能返回null.
	 */
	String getX509Encrypted();
	
	/**
	 * 需要解密的类名
	 * @return {@link Set}
	 */
	Set<String> getDecryptClassNames();
	
	/**
	 * 需要解密的脚本文件， 文件名应包括classPath的相对路径部份。
	 * @return {@link Set}
	 */
	Set<String> getDescryptScriptFileNames();
}
